#
# Copyright (C) 2005, 2006  Matthew A. Nicholson
# Copyright (C) 2006  Tim Blechmann
# Copyright (C) 2011 Michael Curran
# Copyright (C) 2014 Alberto Buffolino
# Copyright (C) 2016 Babbage B.V.
# Based on code from http://www.scons.org/wiki/DoxygenBuilder
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 2.1 as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import os
import os.path
import glob
from fnmatch import fnmatch
from functools import reduce
import winreg


def fetchDoxygenPath():
	try:
		with winreg.OpenKey(
			winreg.HKEY_LOCAL_MACHINE,
			r"SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\doxygen_is1",
			access=winreg.KEY_READ | winreg.KEY_WOW64_64KEY,
		) as doxygenKey:
			doxygenPath = '"%s"' % os.path.join(
				winreg.QueryValueEx(doxygenKey, "InstallLocation")[0],
				"Bin",
				"doxygen.exe",
			)
	except WindowsError:
		return "doxygen"
	return doxygenPath


def DoxyfileParse(file_contents):
	"""
	Parse a Doxygen source file and return a dictionary of all the values.
	Values will be strings and lists of strings.
	"""
	data = {}

	import shlex

	lex = shlex.shlex(instream=file_contents, posix=True)
	lex.wordchars += "*+./-:"
	lex.whitespace = lex.whitespace.replace("\n", "")
	lex.escape = ""

	token = lex.get_token()
	key = token  # the first token should be a key
	last_token = ""
	key_token = False
	new_data = True

	def append_data(data, key, new_data, token):
		if new_data or len(data[key]) == 0:
			data[key].append(token)
		else:
			data[key][-1] += token

	while token:
		if token in ["\n"]:
			if last_token not in ["\\"]:
				key_token = True
		elif token in ["\\"]:
			pass
		elif key_token:
			key = token
			key_token = False
		else:
			if token == "+=":
				if key not in data:
					data[key] = list()
			elif token == "=":
				data[key] = list()
			else:
				append_data(data, key, new_data, token)
				new_data = True

		last_token = token
		token = lex.get_token()

		if last_token == "\\" and token != "\n":
			new_data = False
			append_data(data, key, new_data, "\\")

	# compress lists of len 1 into single strings
	# Wrap items into a list, since we're mutating the dictionary
	for k, v in list(data.items()):
		if len(v) == 0:
			data.pop(k)

		# items in the following list will be kept as lists and not converted to strings
		if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS"]:
			continue

		if len(v) == 1:
			data[k] = v[0]

	return data


def DoxySourceScan(node, env, path):
	"""
	Doxygen Doxyfile source scanner.  This should scan the Doxygen file and add
	any files used to generate docs to the list of source files.
	"""
	default_file_patterns = [
		"*.c",
		"*.cc",
		"*.cxx",
		"*.cpp",
		"*.c++",
		"*.java",
		"*.ii",
		"*.ixx",
		"*.ipp",
		"*.i++",
		"*.inl",
		"*.h",
		"*.hh ",
		"*.hxx",
		"*.hpp",
		"*.h++",
		"*.idl",
		"*.odl",
		"*.cs",
		"*.php",
		"*.php3",
		"*.inc",
		"*.m",
		"*.mm",
		"*.py",
	]

	default_exclude_patterns = [
		"*~",
	]

	sources = []

	with open(node.abspath) as contents:
		data = DoxyfileParse(contents)

	if data.get("RECURSIVE", "NO") == "YES":
		recursive = True
	else:
		recursive = False

	file_patterns = data.get("FILE_PATTERNS", default_file_patterns)
	exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns)

	for node in data.get("INPUT", []):
		if os.path.isfile(node):
			sources.append(node)
		elif os.path.isdir(node):
			if recursive:
				for root, dirs, files in os.walk(node):
					for f in files:
						filename = os.path.join(root, f)

						pattern_check = reduce(
							lambda x, y: x or bool(fnmatch(filename, y)),
							file_patterns,
							False,
						)
						exclude_check = reduce(
							lambda x, y: x and fnmatch(filename, y),
							exclude_patterns,
							True,
						)

						if pattern_check and not exclude_check:
							sources.append(filename)
			else:
				for pattern in file_patterns:
					sources.extend(glob.glob("/".join([node, pattern])))

	sources = [env.File(path) for path in sources]
	return sources


def DoxySourceScanCheck(node, env):
	"""Check if we should scan this file"""
	return os.path.isfile(node.path)


def DoxyEmitter(source, target, env):
	"""Doxygen Doxyfile emitter"""
	# possible output formats and their default values and output locations
	output_formats = {
		"HTML": ("YES", "html"),
		"LATEX": ("YES", "latex"),
		"RTF": ("NO", "rtf"),
		"MAN": ("NO", "man"),
		"XML": ("NO", "xml"),
	}

	with open(source[0].abspath) as contents:
		data = DoxyfileParse(contents)

	targets = []
	out_dir = source[0].Dir(data.get("OUTPUT_DIRECTORY", "."))

	# add our output locations
	for k, v in list(output_formats.items()):
		if data.get("GENERATE_" + k, v[0]) == "YES":
			targets.append(out_dir.Dir(v[1]))

	# set up cleaning stuff
	for node in targets:
		env.Clean(node, node)

	return (targets, source)


def generate(env):
	"""
	Add builders and construction variables for the
	Doxygen tool.  This is currently for Doxygen 1.4.6.
	"""
	doxyfile_scanner = env.Scanner(
		DoxySourceScan,
		"DoxySourceScan",
		scan_check=DoxySourceScanCheck,
	)

	import SCons.Builder

	doxyfile_builder = SCons.Builder.Builder(
		action="cd ${SOURCE.dir}  &&  ${DOXYGEN} ${SOURCE.file}",
		emitter=DoxyEmitter,
		single_source=True,
		source_scanner=doxyfile_scanner,
	)

	env.Append(
		BUILDERS={
			"Doxygen": doxyfile_builder,
		},
	)

	env.AppendUnique(
		DOXYGEN=fetchDoxygenPath(),
	)


def exists(env):
	"""
	Make sure doxygen exists.
	"""
	return bool(fetchDoxygenPath())
